# Q. What is this file?
# A. This file contains options which allow you to configure your multiworld experience while allowing
#    others to play how they want as well.
#
# Q. How do I use it?
# A. The options in this file are weighted. This means the higher number you assign to a value, the
#    more chances you have for that option to be chosen. For example, an option like this:
#
#    map_shuffle:
#      on: 5
#      off: 15
#
#    Means you have 5 chances for map shuffle to occur, and 15 chances for map shuffle to be turned
#    off.
#
# Q. I've never seen a file like this before. What characters am I allowed to use?
# A. This is a .yaml file. You are allowed to use most characters.
#    To test if your yaml is valid or not, you can use this website:
#        http://www.yamllint.com/
#    You can also verify that your Archipelago options are valid at this site:
#        https://archipelago.gg/check

# Your name in-game, limited to 16 characters.
#     {player} will be replaced with the player's slot number.
#     {PLAYER} will be replaced with the player's slot number, if that slot number is greater than 1.
#     {number} will be replaced with the counter value of the name.
#     {NUMBER} will be replaced with the counter value of the name, if the counter value is greater than 1.
name: Player{number}

# Used to describe your yaml. Useful if you have multiple files.
description: Default Mini Metro Template

game: Mini Metro
requires:
  version: 0.6.7 # Version of Archipelago required for this yaml to work as expected.

Mini Metro:
  ################
  # Game Options #
  ################
  progression_balancing:
    # A system that can move progression earlier, to try and prevent the player from getting stuck and bored early.
    # 
    # A lower setting means more getting stuck. A higher setting means less getting stuck.
    #
    # You can define additional values between the minimum and maximum values.
    # Minimum value is 0
    # Maximum value is 99
    random: 0
    random-low: 0 # random value weighted towards lower values
    random-high: 0 # random value weighted towards higher values
    random-range-0-99: 0 # random value between 0 and 99
    disabled: 0 # equivalent to 0
    normal: 50 # equivalent to 50
    extreme: 0 # equivalent to 99

  accessibility:
    # Set rules for reachability of your items/locations.
    # 
    # **Full:** ensure everything can be reached and acquired.
    # 
    # **Minimal:** ensure what is needed to reach your goal can be acquired.
    full: 50
    minimal: 0

  starting_maps:
    # Number of maps to start with unlocked
    #
    # You can define additional values between the minimum and maximum values.
    # Minimum value is 1
    # Maximum value is 34
    5: 50
    random: 0
    random-low: 0 # random value weighted towards lower values
    random-high: 0 # random value weighted towards higher values
    random-range-1-34: 0 # random value between 1 and 34

  maps_to_complete:
    # Number of maps to complete for victory when Goal is set to Complete Maps.
    # Ignored when Goal is set to Goal Map.
    #
    # You can define additional values between the minimum and maximum values.
    # Minimum value is 1
    # Maximum value is 34
    20: 50
    random: 0
    random-low: 0 # random value weighted towards lower values
    random-high: 0 # random value weighted towards higher values
    random-range-1-34: 0 # random value between 1 and 34

  target_week:
    # Target week level to complete.
    #
    # You can define additional values between the minimum and maximum values.
    # Minimum value is 3
    # Maximum value is 10
    9: 50
    random: 0
    random-low: 0 # random value weighted towards lower values
    random-high: 0 # random value weighted towards higher values
    random-range-3-10: 0 # random value between 3 and 10

  max_weeks:
    # Maximum number of weeks per map
    #
    # You can define additional values between the minimum and maximum values.
    # Minimum value is 3
    # Maximum value is 10
    9: 50
    random: 0
    random-low: 0 # random value weighted towards lower values
    random-high: 0 # random value weighted towards higher values
    random-range-3-10: 0 # random value between 3 and 10

  game_mode:
    # Game mode to play:
    # Classic: Standard Mini Metro rules.
    # Extreme: Lines cannot be redrawn after being placed.
    classic: 50
    extreme: 0

  trap_chance:
    # Percentage of filler items replaced with traps:
    # Rush Hour: A station gets overcrowded.
    # Renovation: Your lines get removed and you must rebuild them from scratch.
    # Delayed: Your next week is delayed by another week.
    # Derailed: One of your trains gets permanently removed.
    #
    # You can define additional values between the minimum and maximum values.
    # Minimum value is 0
    # Maximum value is 100
    20: 50
    random: 0
    random-low: 0 # random value weighted towards lower values
    random-high: 0 # random value weighted towards higher values
    random-range-0-100: 0 # random value between 0 and 100

  map_shard_mode:
    # How many shards the player must collect to unlock each map.
    # Static: pre-calculated from Max Weeks (max(max_weeks - 1 if max_weeks < 5 else max_weeks - 2, 1)).
    # Custom: use the value of Custom Shard Count below.
    static: 50
    custom: 0

  custom_shard_count:
    # Shards required per map when Map Shard Count Mode is set to Custom. Ignored
    # in Static mode. Higher values mean longer per-map gating between unlocks.
    #
    # You can define additional values between the minimum and maximum values.
    # Minimum value is 1
    # Maximum value is 10
    5: 50
    random: 0
    random-low: 0 # random value weighted towards lower values
    random-high: 0 # random value weighted towards higher values
    random-range-1-10: 0 # random value between 1 and 10

  goal:
    # Victory condition:
    # Complete Maps: clear Target Week on the configured number of maps (Maps to Complete).
    # Goal Map: clear Target Week on a single chosen map (Goal Map below).
    complete_maps: 50
    goal_map: 0

  goal_map:
    # The map whose Target Week must be cleared to win when Goal is set to Goal Map. Ignored for the Complete Maps goal.
    london: 50
    paris: 0
    new_york_city: 0
    warsaw: 0
    lisbon: 0
    tokyo: 0
    chicago: 0
    budapest: 0
    berlin: 0
    melbourne: 0
    hong_kong: 0
    barcelona: 0
    osaka: 0
    stockholm: 0
    saint_petersburg: 0
    boston: 0
    montreal: 0
    san_francisco: 0
    sao_paulo: 0
    seoul: 0
    santiago: 0
    washington_dc: 0
    tashkent: 0
    singapore: 0
    cairo: 0
    istanbul: 0
    shanghai: 0
    guangzhou: 0
    nanjing: 0
    chongqing: 0
    mumbai: 0
    addis_ababa: 0
    lagos: 0
    auckland: 0

  death_link:
    # When you die, everyone who enabled death link dies. Of course, the reverse is true too.
    'false': 50
    'true': 0

  ###########################
  # Item & Location Options #
  ###########################
  local_items:
    # Forces these items to be in their native world.
    []

  non_local_items:
    # Forces these items to be outside their native world.
    []

  start_inventory:
    # Start with the specified amount of these items. Example: "Bomb: 1"
    {}

  start_hints:
    # Start with these item's locations prefilled into the ``!hint`` command.
    []

  start_location_hints:
    # Start with these locations and their item prefilled into the ``!hint`` command.
    []

  exclude_locations:
    # Prevent these locations from having an important item.
    []

  priority_locations:
    # Prevent these locations from having an unimportant item.
    []

  item_links:
    # Share part of your item pool with other players.
    []

  plando_items:
    # Generic items plando.
    []
